home *** CD-ROM | disk | FTP | other *** search
/ Especial Multimedia / Especial Multimedia.iso / Multimed / Musica / MODPLUG.ZIP / README.TXT < prev    next >
Text File  |  1997-04-04  |  15KB  |  420 lines
  1. /*****************************************************\
  2. *      MOD Plugin - (c) 1997 by Olivier Lapicque      *
  3. *                                                     *
  4. *               - Distribute freely -                 *
  5. *                                                     *
  6. *         contact: c1lapicq@watson.ibm.com            *
  7. *                                                     *
  8. *    (Special thanks to MisterX for the graphics)     *
  9. \*****************************************************/
  10.  
  11.  
  12. - 1. Requirements
  13. - 2. Installation
  14. - 3. How do I use the MOD Plugin in my HTML files ?
  15. - 4. Can I use the MOD plugin to play my modules on my
  16.      local hard drive ?
  17. - 5. What's new ?
  18. - 6. Troubleshooting
  19.  
  20. -------------------------------------------------------
  21. 1. Requirements
  22. -------------------------------------------------------
  23.  
  24. - DX2-66 or higher
  25. - Windows 95 or NT 4.0.
  26. - A soundcard with 32-bit drivers
  27. - Netscape Navigator 2.0 or higher,
  28.   or Microsoft Internet Explorer 3.0
  29.  
  30. NOTE:
  31.   44.1KHz sound quality is not recommended for computers
  32.   slower than a 486DX4-100.
  33.  
  34. MOD-Plugin is a freeware and may be freely distributed.
  35. As it is a freeware, I am not responsible for any
  36. problems that could be caused by the usage of this plugin.
  37.  
  38. To save a song, or configure the sound quality, right-click
  39. on the controls, and a menu will be displayed.
  40. MOD-Plugin doesn't support instrument envelopes. You should
  41. use the Save As option of your browser if you don't want to
  42. lose envelope information in XM modules.
  43.  
  44. Setup Options:
  45. --------------
  46.  
  47. - Mixing Rate, Stereo, 16-Bit: quality of the sound
  48.  
  49. - Pre-Amplification: increases the volume of the song, the formula
  50.   is preamp_vol = vol * (1 + numchannels / 12), this gives a better
  51.   signal/noise ratio. If the sound cracks, you should decrease
  52.   the volume of the song (or change the volume=x statement in the
  53.   EMBED tag). Clipping is now done with version 1.57+, which takes
  54.   a little bit more CPU time.
  55.  
  56. - Surround: Mix according to the Dolby Pro-Logic specs.
  57.   (I never actually tried it) Use it only if you have
  58.   a Dolby Pro-Logic amplifier connected to your PC.
  59.  
  60. - Reverb: Add reverb effect to the song when playing.
  61.  
  62. - Disable oversampling: you should not use this option,
  63.   unless you have a slow CPU. You can try to listen to
  64.   the music with and without oversampling to see the
  65.   difference.
  66.  
  67. - Save packed songs: pack the samples when saving songs,
  68.   using the Sae As command (Can reduce up to 50% the size of the
  69.   song).
  70.  
  71. ---------------------------------------------------------
  72. 2. Installation
  73. ---------------------------------------------------------
  74.  
  75. - Execute setup.exe (in the same directory than where it
  76.   is located, if you run it from a DOS prompt), and follow
  77.   the instructions.
  78.  
  79. - Launch your browser (If it was already launched, you'll
  80.   need to quit and restart it).
  81.  
  82. - Turn up the volume VERY loud.
  83.  
  84. - Open MODLINKS.HTM file in your browser, which includes
  85.   a few links to some MOD pages.
  86.  
  87. - Don't forget to check Kim's MOD Page.
  88.  
  89.  
  90. ---------------------------------------------------------
  91. 3. How do I use the MOD Plugin in my HTML files ?
  92. ---------------------------------------------------------
  93.  
  94. The syntax to put a song in your page is the following:
  95.  
  96. <EMBED SRC="whatever.mod" width="145" height="48" ...>
  97.  
  98. NOTE:
  99.   On a Web server, the command should also include the mime-type:
  100.  
  101. <EMBED type="audio/mod" src="whatever.mod" ...
  102.  
  103. The mime-type used by the MOD Plugin are the following:
  104. audio/mod
  105. audio/s3m
  106. audio/xm
  107. audio/med
  108. audio/mtm
  109.  
  110. But you can always put any mime type for different file types:
  111. audio/mod works with a s3m file, and vice-versa.
  112.  
  113. That's it!
  114.  
  115. * You can also play WOW and NST files: just rename them in .MOD.
  116.  
  117. NOTE: Don't forget to use the packing option of the plugin:
  118.   you'll need to use the "Save packed songs" options in the
  119.   setup dialog, and save the song. This can make the file
  120.   twice smaller. When the user will download the file from
  121.   your page, it will be unpacked. It can make a big difference
  122.   when downloading a file larger than 200K.
  123.  
  124.  
  125. The other options you may want to add are the following:
  126. - volume="x": set the volume of the song to x.
  127.   (Default="100", range="1" to "100")
  128.  
  129. - loop="true": Loop the song. (Default:"false")
  130.  
  131. - autostart="true": Start playing the song when loaded.
  132.   (Default="false"). (Also "autoplay" on versions 1.31+)
  133.  
  134. - autonext="true": Jump to next mod when finished playing.
  135.   (Default="false") This is useful only if you have more
  136.   than one song in your page.
  137.  
  138. - controls="smallconsole": shows a small control for the
  139.   song, without displaying the title, and without volume
  140.   control. In this case, the height parameter should be
  141.   set to "15".
  142.  
  143. - controls="none": don't display anything - use with care
  144.   because there is no way the user will be able to stop the
  145.   mod (besides exiting the page)
  146.  
  147. - hidden="true": same as controls="none".
  148.  
  149. - title="song_title": Displays the text "song_title" when
  150.   the song is not yet loaded. (Default: displays nothing)
  151.   You can use this to display "Loading... Please wait"
  152.   while the browser is loading the module.
  153.  
  154. - shuffle="true" (1.57+): goes along with autonext="true".
  155.   when a song finishes playing, the next song will be randomly
  156.   chosen. The shuffle option is a global flag and should appear
  157.   on the first EMBED section in the page. This flags sets
  158.   the autonext="true" flag automatically.
  159.  
  160. - bgcolor="black","gray" (1.60+): Select a background color
  161.   for the plugin.
  162.  
  163. NOTE: (v1.43+)
  164. --------------
  165. - If you want to enable the VU-Meter, the width parameter
  166.   should be set to "168". The VU-Meter cannot be used with
  167.   the controls="smallconsole" option.
  168.  
  169. Spectrum Analyzer (1.60+)
  170. -------------------------
  171. - You can enable the spectrum analyzer by setting a height
  172.   of 96 (bottom spectrum) or a width of 336 (right spectrum).
  173.  
  174.  
  175. --------------------------------------------------------
  176. 4. Can I use the MOD plugin to play my modules on my
  177.    local hard drive ?
  178. --------------------------------------------------------
  179.  
  180. Well, of course.
  181. Create a modlist.htm file in your modules directory,
  182. with a line for each module (Try not to put more than
  183. 10 mods on the same page, because they will all be 
  184. loaded in memory)
  185.  
  186. The file should look like that:
  187.  
  188. <HTML>
  189. <HEAD>
  190. <TITLE>Ultra-trance-tekkno-rave mod page</TITLE>
  191. </HEAD>
  192. <BODY>
  193.  
  194. <P><A HREF="prevpage.htm">Previous Page</A></P>
  195.  
  196. <P><EMBED SRC="mod01.mod" width="145" height="48" autostart="true" autonext="true"></P>
  197. <P><EMBED SRC="mod02.mod" width="145" height="48" autonext="true"></P>
  198. <P><EMBED SRC="mod03.s3m" width="145" height="48" autonext="true"></P>
  199.  
  200. <P><A HREF="nextpage.htm">Next Page</A></P>
  201.  
  202. </BODY>
  203. </HTML>
  204.  
  205. * end of file *
  206.  
  207. After that, you can open this file in Netscape in
  208. File - Open File in Browser.
  209.  
  210. And voila !
  211.  
  212.  
  213.  
  214. --------------------------------------------------------
  215. 5. What's new ?
  216. --------------------------------------------------------
  217.  
  218. ------------- MOD Plugin version 1.6 -------------------
  219. 1.60:
  220. - Added MTM modules support (import).
  221. - Fixed VU-Meter bug when Surround was used.
  222. - Added 20-bands Spectrum Analyzer
  223. - Added Panning Slide effect in XM modules.
  224. - Added Reverb option.
  225. - Reduced total size of sound buffer from 1.6s to 1s.
  226.  
  227. ------------- MOD Plugin version 1.5 -------------------
  228. 1.57:
  229. - The replay routine runs now in a separate thread.
  230. - Improved the Pre-Amplification option by clipping the sound.
  231. - Added "shuffle" option.
  232.  
  233. 1.56:
  234. - MAJOR BUG FIX: Save As was corrupting MOD files with version 1.55
  235. - Decreased size of sound buffer but increased number of buffers
  236. - Fixed bug in S3M when sample loop end was bigger than sample length.
  237. - "Loading..." is displayed when loading a module.
  238.  
  239. 1.55:
  240. - Fixed WAV file format bug.
  241. - Fixed font display bug when displaying the song title.
  242. - Updated MODLINKS.HTM
  243.  
  244. 1.54:
  245. - Added FastVolSlide & AmigaLimits flags in S3M modules.
  246. - Fixed Speed 0 bug in MOD/XM.
  247. - Fixed XM instrument panning bug.
  248. - Fixed finetune bug in MODs.
  249. - Fixed vibrato bug
  250. - Too high frequencies are not played anymore (>200KHz).
  251. - Added support for linear frequencies in XM modules.
  252. - Added Save As Wave option (.wav export)
  253.  
  254. 1.53:
  255. - Instruments are now saved unsigned in s3m MODULES.
  256. - Unused channels are now removed in S3M modules..
  257. - Pattern Break bug fixed in XM modules.
  258. - Song slider bug fixed.
  259.  
  260. 1.52:
  261. - Added OctaMed MMD2/MMD3 support.
  262. - Song slider bug fixed.
  263. - Minor bugs fixed.
  264.  
  265. 1.51:
  266. - Added basic support for OctaMed MMD0/MMD1 Modules (*.med)
  267. - Added audio/x-xm and audio/x-s3m MIME-type (They were removed
  268.   in 1.50 - but I saw some sites using them)
  269.  
  270. 1.50:
  271. - Added support for 16-bit samples (S3M,XM)
  272. - Fixed VolSlide(0) in MODs
  273. - Optimized play function
  274.  
  275. ------------- MOD Plugin version 1.4x -------------------
  276.  
  277. - Now set the correct tempo when changing the position
  278. - Improved XM support (fixed tempo<->speed) bug.
  279. - Added Pro-Logic Surround and Pre-Amplicication options.
  280. - Added XM key off/fadeout support.
  281. - Added E8x effect in MOD/XM.
  282. - Added 32KHz and 48KHz sound quality.
  283. - Added X1/X2 effects in XM files.
  284. - Added default "Loading..." while downloading a file.
  285. - Fixed possible crash with Note Delay effect.
  286. - Fixed Offset 0 effect bug
  287. - Fixed retrig bug
  288. - Fixed FineTune bug
  289. - Fixed arpeggio bug
  290. - Fixed volume slide bug in S3m.
  291. - Fixed setup bug for MSIE when the plugins directory
  292.   didn't exist.
  293. - Recognises "looping" same as "loop" (for compatibility
  294.   with the DSM Mac plugin).
  295. - Fixed bug when "properties" was used before the module
  296.   was loaded. (Properties screen was staying blank)
  297. - Fixed VU-Meter bug in 8-bit format (always in the red)
  298. - Fixed a problem that caused clicks in some loops
  299. - Fixed S3M bug in Fine & Extra Fine Portamento Up/Down
  300. - Fixed Note Delay problem with non-zero volume column byte
  301. - Added MODLINKS.HTM to the package.
  302. - Added VU-Meter.
  303. - Added Glissando Control.
  304. - Remember the last song position.
  305. - Added multisample instrument support in XM files.
  306. - Changed SETUP.EXE to support Internet Explorer.
  307.  
  308. ------------- MOD Plugin version 1.3x ------------------
  309.  
  310. - Fixed bugs with Note Delay, Tremor and Retrigger.
  311. - Added Save As for XM files (multisample instruments
  312.   are not supported yet)
  313. - Improved S3M Load/Save function
  314. - Support for patterns with more than 64 rows in XM files.
  315. - Minor other adjustments
  316. - Added support for 16-bit samples
  317. - Added effects on XM files.
  318. - Added "hidden" option (same as "controls="none").
  319. - Added Note Delay effect in MODs (EDx).
  320. - Increased size of sound buffer.
  321. - MAJOR bug fix in s3m modules.
  322. - Added basic XM support (no effects and no Save As...).
  323. - Fixed Netscape crash when changing page before load completed
  324. - Added channel pan position effect.
  325. - Added support with up to 32 channels for s3m modules.
  326. - Added autoplay same than autostart.
  327. - Added 4-bit ADPCM support for modules: this can make the module
  328.   twice smaller! But WARNING: your other players/trackers will
  329.   probably not support ADPCM, and will not be able to load the
  330.   samples -> By default, the plugin will unpack the songs when
  331.   saving. If you want to pack them, check the "Save packed songs"
  332.   checkbox in the Setup dialog, and use the Save As command.
  333.   If the "Save packed song" option is not checked, the song will
  334.   be save unpacked, even if it was packed before. It can then be
  335.   loaded by any tracker/player.
  336.  
  337.   This is very useful for the internet since it will be twice faster
  338.   to download the module. (Think about it if you want to put a module
  339.   on your home page)
  340.  
  341.   ATTENTION DEVELOPPERS: (If you want to support the packed format)
  342.   When saving the song, the plugin will pack the samples only if
  343.   it doesn't affect the quality. In MOD files, the sample data starts
  344.   by "ADPCM". In S3M the regular compression byte is used with a value
  345.   of 0x04. 4-bit ADPCM is coding the delta values between a sample and
  346.   the next in 4-bits (starting value is zero). The delta values are
  347.   stored as a 16-byte table at the start of the sample data:
  348.   [16-bytes delta values][(length+1)/2 bytes of 4-bit indexes...]
  349.   In XM files, the bit 6 of the sample type is set to 1, and the reserved
  350.   byte is set to 0xAD.
  351.  
  352.  
  353. ------------- MOD Plugin version 1.2x ------------------
  354.  
  355. - Added Retrig effect on MOD files (E9x command)
  356. - Added Pattern Delay effect on MOD files (EEx command)
  357. - Added Pattern Loop effect
  358. - Added 'title' option.
  359. - Added S3M support
  360. - Added channels, instruments and patterns in the 
  361.   properties box.
  362. - Fixed some clicks problems in modules with an odd
  363.   number of channels.
  364. - Added README.TXT (this file).
  365.  
  366.  
  367. ------------- MOD Plugin version 1.1 -------------------
  368.  
  369. - Fixed problems with some NT sound drivers.
  370. - Fixed "Netscape will launch the application..." 
  371.   message when you had a mod player already installed.
  372. - Added support for mods with more than 16 channels.
  373.  
  374.  
  375. ------------- MOD Plugin version 1.0 -------------------
  376.  
  377. First release of the plugin.
  378.  
  379. - Support up to 16 channels mods.
  380. - Sound interpolation for each track remove metallic
  381.   quality of the sound. (Like what the GUS does in 
  382.   hardware) (256x oversampling)
  383.  
  384.  
  385. -------------------------------------------------------
  386. 6. Troubleshooting
  387. -------------------------------------------------------
  388.  
  389.  
  390. - The setup.exe program failed!
  391.  
  392.   Be sure to run the program setup.exe in the same directory
  393.   than where the npmod32.dll file is located.
  394.   Try to copy the file NPMOD32.DLL in the plugins
  395.   directory of your browser if it's still not working.
  396.  
  397.  
  398. - I don't like the MOD Plugin, it's crap and I hate it.
  399.  
  400.   Ta mere elle chausse du 2.
  401.  
  402.  
  403. - I have a Mac, how can I get MOD Plugin for Mac ?
  404.  
  405.   A plugin is already available for Mac (PowerPC only).
  406.   Check at: "http://www.spilk.org/dsm". (DSM Plugin)
  407.   This plugin doesn't support compression.
  408.  
  409. - I'm running OS/2, how can I get MOD Plugin for OS/2 ?
  410.  
  411.   An OS/2 plugin is available at the following address:
  412.   "http://www.polsci.wvu.edu/Henry/Madbrain/npdsmi.html"
  413.   (DSMI/2 doesn't support compression yet)
  414.  
  415. - For all other questions about the MOD Plugin, e-mail me
  416.   at c1lapicq@watson.ibm.com, and don't forget to tell me
  417.   which version of the plugin you're using.
  418.  
  419.  
  420.